home *** CD-ROM | disk | FTP | other *** search
/ Shareware Super Platinum 8 / Shareware Super Platinum 8.iso / mac / DATABASE / DVER20.ZIP;1 / DVER.HLP < prev    next >
Encoding:
Text File  |  1993-03-08  |  10.8 KB  |  433 lines
  1. .*PROGRAM dVERSION 2.0
  2. .*PROGRAMMER D. ALLEN
  3. .*CREATED SEPT 1, 1987
  4. .*UPDATED MAR 06, 1993
  5. .*COPYRIGHT (C) 1987
  6. Overview:  dVERSION is a dBASE text translator.  It was designed
  7. to give the dBASE programmer a facility to maintain dBASE code.
  8.  
  9. Essentially, dVERSION will conditionally translate dBASE code.
  10. This allows the programmer to have many versions of an
  11. application in one set of source code.  In addition, dVERSION
  12. offers an INCLUDE facility that can insert code from specified
  13. source files.
  14.  
  15. For more information on any dVERSION command, type HELP TOPICS
  16. and press <ENTER>.
  17.  
  18. .L 1 TOPICS
  19. The following topics are available for dVERSION:
  20.  
  21.      TOPICS              COMMANDS            BLK_CMD
  22.      CLEAR_CMD           CLS_CMD             HELP_CMD
  23.      HLP_CMD             IN_CMD              LIST_CMD
  24.      OUT_CMD             PAR_CMD             PARMS_CMD
  25.      PMT_CMD             QUIT_CMD            REM_CMD
  26.      REMOVE_CMD          RUN_CMD             SUF_CMD
  27.      SYSTEM_CMD          ERRORS              SAMPLE
  28.  
  29. .L 1 COMMANDS
  30. The following is a summary of all dVERSION commands:
  31.  
  32. BLK ON               - leading blanks are to be removed
  33.                        from output code
  34. CLEAR                - reset all commands to their defaults
  35. CLS                  - clear screen and home cursor
  36. HELP topic           - displays topic from the help file
  37. HLP filespec         - filespec is the dVERSION help file
  38. IN filespec          - filespec is the dVERSION input file
  39. LIST LPT2            - send all source code to printer LPT2
  40. OUT filespec         - filespec is the dVERSION output file
  41. PAR word             - specifies word as a conditional parameter
  42. PARMS filespec       - filespec is the dVERSION parameter file
  43. PMT .                - sets the dVERSION prompt character to "."
  44. QUIT                 - exit dVERSION and enter DOS
  45. REM ON               - remarks are to be removed from output code
  46. REMOVE ON            - remove all trace of specified parameters
  47. RUN                  - starts program processing
  48. SUF #                - sets the dVERSION reserved word suffix to "#"
  49. SYSTEM               - displays the current directory
  50.  
  51. .L 1 BLK_CMD
  52.  
  53.  
  54. SYNTAX:  BLK [flag]
  55.  
  56. PARAMETERS:
  57. flag           -    optional, ON or OFF
  58.  
  59. DESCRIPTION:  Sets the option to remove leading blanks from
  60. output code.  If no flag is specified, the current status is
  61. displayed.  The default is OFF.
  62.  
  63.  
  64. .L 1 CLEAR_CMD
  65.  
  66.  
  67. SYNTAX:  CLEAR [command]
  68.  
  69. PARAMETERS:
  70. command        -    any dVERSION command
  71.  
  72. DESCRIPTION:  Sets the specified dVERSION command to it's
  73. default value.  If command is not specified, all commands are
  74. reset to their defaults.
  75.  
  76.  
  77. .L 1 CLS_CMD
  78.  
  79.  
  80. SYNTAX:  CLS
  81.  
  82. PARAMETERS:  none
  83.  
  84. DESCRIPTION:  This command clears the screen and homes the cursor.
  85.  
  86.  
  87. .L 1 HELP_CMD
  88.  
  89.  
  90. SYNTAX:  HELP [topic] [topic] ...
  91.          or
  92.          ? [topic] [topic] ...
  93.  
  94. PARAMETERS:
  95. topic          -    any valid help topic
  96.  
  97. DESCRIPTION:  The help facility provides the user a means of
  98. displaying information on certain topics.  The HELP command
  99. will open a help file and will search for a specified topic. 
  100. The ? is a HELP extension that will not reopen the help file,
  101. but will search for a specified topic.
  102.  
  103. If more than one topic is specified, a search is made until
  104. each subtopic is found.  If no topics are specified, then the
  105. next available topic is displayed.  For a summary of topics,
  106. type HELP TOPICS.
  107.  
  108.  
  109. .CONT
  110. EXAMPLE 1:
  111.  
  112.      HELP HLP_CMD EXAMPLE
  113.  
  114. The help file is opened.  A search is made for the topic
  115. HLP_CMD, and then for the subtopic EXAMPLE.  If found, the
  116. subtopic EXAMPLE is displayed.
  117.  
  118.  
  119. .CONT
  120. EXAMPLE 2:
  121.  
  122.      HELP HLP
  123.  
  124. If a topic is less than 5 characters, HELP will search for the
  125. first topic whose beginning characters match it.  In our case,
  126. the subject topic is HLP.  A search is made of any topic whose
  127. first characters match HLP.
  128.  
  129. Having found HLP, suppose we want to see the HLP EXAMPLE.  We
  130. can type:
  131.  
  132.      ?EXAMPLE
  133.  
  134. ? can be used instead of HELP.  It merely indicates that the
  135. help file need not be closed, and the topic search need not
  136. start from the beginning of the help file.
  137.  
  138.  
  139. .L 1 HLP_CMD
  140.  
  141.  
  142. SYNTAX:  HLP [filespec]
  143.  
  144. PARAMETERS:
  145. filespec       -    any DOS path\filename.ext
  146.  
  147. DESCRIPTION:  Sets the HELP file name.  If no file is
  148. specified, the current file is displayed.  This command is
  149. commonly used to allow the HELP file to be stored on a
  150. memory disk.  The default is DVER.HLP.
  151.  
  152.  
  153. .L 1 IN_CMD
  154.  
  155.  
  156. SYNTAX:  IN [filespec]
  157.  
  158. PARAMETERS:
  159. filespec       -    any DOS path\filename.ext
  160.  
  161. DESCRIPTION:  Sets the input file parameter.  This command
  162. specifies the dVERSION source file.  Wildcards "*" and "?" are
  163. allowed.  If no filespec is specified, the current input file
  164. is displayed.
  165.  
  166.  
  167. .L 1 LIST_CMD
  168.  
  169.  
  170. SYNTAX:  LIST [flag or port]
  171.  
  172. PARAMETERS:
  173. flag           -    optional, ON or OFF
  174. port           -    any printer port (LPT1, COM1, etc.)
  175.  
  176. DESCRIPTION:  Sets the option to send all input/include files
  177. to the printer.  If no option is specified, the current flag is
  178. displayed.  If the current flag is on, the port is displayed.
  179. Specifying a port sets the flag to ON.  The default flag is OFF.
  180.  
  181.  
  182. .L 1 OUT_CMD
  183.  
  184.  
  185. SYNTAX:  OUT [filespec]
  186.  
  187. PARAMETERS:
  188. filespec       -    any DOS path\filename.ext
  189.  
  190. DESCRIPTION:  Sets the output file parameter.  This command
  191. specifies the output file.  If no filespec is specified,
  192. the current output file is displayed.  If no file extension is
  193. specified, the last known extension is assumed.  The default
  194. output file is "*.PRG".
  195.  
  196. Note:  If the IN command has a wildcard, the OUT command's
  197. filename is ignored (path and file extension are still used).
  198.  
  199.  
  200. .L 1 PAR_CMD
  201.  
  202.  
  203. SYNTAX:  PAR [word or number]
  204.  
  205. PARAMETERS:
  206. word           -    any valid dBASE variable
  207. number         -    number of leading spaces
  208.  
  209. DESCRIPTION:  Adds word to a list of conditional translating
  210. parameters.  All code specified as conditional upon word will
  211. be translated.  If no parameter is specified, all parameters
  212. currently in the list are displayed.
  213.  
  214. If a number is specified, leading spaces will be removed from
  215. every statement within each conditional.
  216.  
  217. Note: See Conditional Translating in the dVERSION manual.
  218.  
  219.  
  220. .L 1 PARMS_CMD
  221.  
  222.  
  223. SYNTAX:  PARMS filespec
  224.  
  225. PARAMETERS:
  226. filespec       -    any DOS path\filename.ext
  227.  
  228. DESCRIPTION:  This command specifies the parameter file.  The
  229. parameter file may contain any valid dVERSION command.  Upon
  230. executing this command, the parameter file is read and each
  231. dVERSION command is executed.
  232.  
  233. Note:  Any Leading prompt character is ignored.  See PMT_CMD.
  234.  
  235.  
  236. .L 1 PMT_CMD
  237.  
  238.  
  239. SYNTAX:  PMT <char>
  240.  
  241. PARAMETERS:
  242. <char>         -    optional, a non alphanumeric character
  243.  
  244. DESCRIPTION:  This command sets the prompt character, recognized
  245. in source code, as a dVERSION command.  If no character is specified,
  246. the current prompt character is displayed.  The default is a ".".
  247.  
  248. Note:  Whatever prompt character you choose, make sure it's the
  249. same prompt character used throughout your source code.
  250.  
  251.  
  252. .L 1 QUIT_CMD
  253.  
  254.  
  255. SYNTAX:  QUIT
  256.  
  257. PARAMETERS:  none
  258.  
  259. DESCRIPTION:  Specifies program exit.  The user is returned to DOS.
  260.  
  261.  
  262. .L 1 REM_CMD
  263.  
  264.  
  265. SYNTAX:  REM [flag]
  266.  
  267. PARAMETERS:
  268. flag           -    optional, ON or OFF
  269.  
  270. DESCRIPTION:  Sets the option to remove all records from
  271. output code that begin with the remark character "*".  If no
  272. command is specified, the current flag is displayed.  The
  273. default for flag is OFF.
  274.  
  275. Note:  Remarks that start with "&&" or "NOTE" are not removed.
  276.  
  277.  
  278. .L 1 REMOVE_CMD
  279.  
  280.  
  281. SYNTAX:  REMOVE [flag]
  282.  
  283. PARAMETERS:
  284. flag           -    optional, ON or OFF
  285.  
  286. DESCRIPTION:  Sets the option to remove all trace of parameters,
  287. specified by the PAR command, in output code.  When set to ON, all
  288. parameters not specified by the PAR command will remain in the
  289. output code.  If no command is specified, the current flag is
  290. displayed.  The default for flag is OFF.
  291.  
  292. Note:  This command allows you to remove parameters, creating a
  293.        fresh set of dVERSION source code.  dVERSION include files,
  294.        therefore, are ignored.
  295.  
  296.  
  297. .L 1 RUN_CMD
  298.  
  299.  
  300. SYNTAX:  RUN
  301.  
  302. PARAMETERS:  none
  303.  
  304. DESCRIPTION:  This command merely begins execution.  This
  305. program will read the input file(s), specified by IN, and will
  306. create the output file(s), specified by OUT.
  307.  
  308.  
  309. .L 1 SUF_CMD
  310.  
  311.  
  312. SYNTAX:  SUF <char>
  313.  
  314. PARAMETERS:
  315. <char>         -    optional, a non alphanumeric character
  316.  
  317. DESCRIPTION:  This command sets the ASCII value for the
  318. dVERSION reserved word suffix.  If no character is specified,
  319. the current suffix character is displayed.  The default is "\".
  320.  
  321. Note:  Whatever suffix character you choose, make sure it's the
  322. same suffix character used throughout your source code.
  323.  
  324.  
  325. .L 1 SYSTEM_CMD
  326.  
  327.  
  328. SYNTAX:  SYSTEM expression
  329.  
  330. PARAMETERS:
  331. expression     -    any DOS command
  332.  
  333. DESCRIPTION:  Allows user access to DOS.  If no expression is
  334. specified, the current directory is displayed.
  335.  
  336. Note:  The expression parameter may or may not work for your DOS
  337. If it does not work, the expression parameter will be ignored.
  338.  
  339.  
  340. .L 1 ERRORS
  341.  
  342.  
  343. The following is a brief description of dVERSION errors:
  344.  
  345. ** Invalid Command
  346.      Either the command was not found, or the command was
  347.      incorrectly typed.  Check your spelling, and retype.
  348.  
  349. ** Topic Not Found
  350.  
  351. ** End of Topic (or Subtopic)
  352.      Merely indicates that the HELP utility found all the
  353.      information it can on a given topic.
  354.  
  355. ** File Name Conflict
  356.      dVERSION cannot continue runtime execution until the IN and
  357.      the OUT commands are correctly specified.  IN also cannot
  358.      equal OUT.
  359.  
  360. ** INCLUDE filespec cannot be opened
  361.      The maximum of 15 files have been opened at one time.
  362.  
  363. ** Device not available, Error#25
  364.      Printer is not online.
  365.  
  366. ** File Not Found, Error#53
  367.  
  368. ** Bad File Name, Error#64
  369.  
  370. ** Syntax Error, Error#
  371.  
  372. ** Disk Error, Error#
  373.      Refer to your Disk owners manual, or to your quick
  374.      basic reference guide.
  375.  
  376.  
  377. .L 1 SAMPLE
  378.  
  379. The following is a sample run and the resulting code:
  380.  
  381. DVER                "Check Manual for correct syntax"
  382. IN SAMP.VER
  383. OUT SAMP.PRG
  384. PAR 2
  385. PAR ISSUE
  386. RUN
  387. QUIT
  388.  
  389.  
  390. .CONT
  391. dVERSION Reference Listing for SAMP.VER
  392. Created at 03:39:18 on 03-07-1993
  393.  
  394.  
  395. ** ' 02/04/89 ISSUE
  396. ** ' 02/04/89 UNITMS
  397.   IF\ .NOT. ISSUE
  398.     *COMMENT
  399.   END\
  400.   IF\ ISSUE
  401.     *COMMENT2
  402.   END\
  403.   IF\ UNITMS
  404.     *COMMENT3
  405.   END\
  406.   IF\ .NOT. UNITMS
  407.     *COMMENT4
  408.   END\
  409.   IF\ ISSUE, UNITMS
  410.     *COMMENT5
  411.   END\
  412.   IF\ .NOT. ISSUE, UNITMS
  413.     *COMMENT6
  414.   END\
  415.   IF\ ISSUE
  416.     *COMMENT7
  417.     IF\ UNITMS
  418.       *COMMENT8
  419.     END\
  420.   END\
  421.  
  422.  
  423. dVERSION Reference Listing for SAMP.PRG
  424.  
  425.  
  426. ** ' 02/04/89 ISSUE
  427. ** ' 02/04/89 UNITMS
  428. *COMMENT2
  429. *COMMENT4
  430. *COMMENT5
  431. *COMMENT7
  432.  
  433.